Get Dynamic Category List
GET : http://<base_url>/digipay/v3/user/dynamic_category
This API used to Save new Dynamic Category Data into the system
QUERY PARAMS:-
Parameter | Type | Description | Value |
---|---|---|---|
name | String | Represents the name associated with an entity. For example, it could be the name of a product or a user | Sample Name |
category_key | String | This field holds a key or identifier for categorizing the entity. It's used to group similar items together, such as products in a specific category. | random_category |
display_order | Int | Indicates the order in which the entity should be displayed. It's an integer value that determines the position in a list or interface. | 3 |
type | Int | Represents the type or classification of the entity. It could denote different variations or classes within a broader category. | 2 |
is_default | Boolean | A boolean flag indicating whether the entity is set as the default option. For instance, it might signify a default setting for a user profile or product choice. | true/false |
no_of_doc_required | Int | Specifies the number of documents required or associated with the entity. This could be relevant for processes requiring documentation submission. | 5 |
user_type | Int | Represents the type of user associated with the entity. It could denote different roles or permissions levels in an application. | 2 |
transaction_pin | String | transaction of amount transfer to another account | 1234 |
user_type | Int | Interger type of user | 2 |
ir_country_id | String | Holds an identifier or code related to a specific country. This could be used to link the entity to a particular country. | IR12345 |
is_active | Boolean | a keyword which can be either name of language or a language code to get desired language as output | true/false |
skip | Int | Skip the first n document from the query result | 1 |
limit | Int | Limits the number of records or documents that you want | 1 |
start_date | Long | unix timestamp value in second | 1 |
end_date | Long | unix timestamp value in second | 1 |
sorting | Long | Sorting of the Data in the form of a string | 123 |
search_keyword | String | a keyword is either name of user compalits logs to search | 123 |
HEADERS:-
Parameter | Type | Description | Value |
---|---|---|---|
Authorization | String | It is a combination of type and token to authenticate user for the given token | Token duik7309njdlkhdauhknksadhjkas986876sd873j |
CompanyID | String | Company_id is a unique primary id, that is represent company detail | 76bc712200ca444fa334f9e55e5fd7a8 |
Request Body:-
Request Example
curl --request GET \
--url 'http://192.168.1.102:8014/digipay/v3/user/dynamic_category?name=Sample%20Name&category_key=random_category&display_order=3&type=2&is_default=false&no_of_doc_required=5&user_type=2&ir_country_id=IR12345&is_active=false&skip=1&limit=1&start_date=1&end_date=1&sorting=123&search_keyword=123' \
--header 'Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NWY0ZDI1MDliZmU0NTBmYTg4MTVhNTU5Njk3YmM0NyIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNjkzNTIxOTU1fQ.9oWwUzlFzmYB1ZOhaVamxKJH6DsMO8tFue2kbg2YyoI' \
--header 'CompanyID: 76bc712200ca444fa334f9e55e5fd7a8' \
--header 'accept: application/json'
Response:-
Response 200(OK)
{
"success": 1,
"error": [],
"data": {
"dynamic_category": [
{
"is_active": true,
"created_by": "65f4d2509bfe450fa8815a559697bc47",
"created_date": 1675334183,
"updated_by": null,
"updated_date": 1675334183,
"id": "880ea7d9cc5f4919946c0fc59081ad17",
"name": "aaa",
"category_key": "Hii",
"display_order": 1,
"type": 2,
"is_default": true,
"no_of_doc_required": 2,
"user_type": 1
}
]
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}
RESPONSES :-
Status Code | Description |
---|---|
200 | OK |
400 | Bad Request |
404 | Not Found |
500 | Internal Server Error |